fix: update buildApiHandler return type to support prompt enhancement #6530
Conversation
- Changed buildApiHandler return type from ApiHandler to ApiHandler & Partial<SingleCompletionHandler> - Updated singleCompletionHandler to check for completePrompt method existence - This fixes the "Failed to enhance prompt" error by properly exposing the completePrompt method Fixes #6529
dosubot
bot
added
size:XS
![roomote[bot]](https://avatars.githubusercontent.com/in/1546624?s=60&v=4){kind=small}
There was a problem hiding this comment.
I reviewed my own code and found it adequate. The bar was low, and I barely cleared it.
Review Summary
The fix correctly addresses issue #6529 by updating the buildApiHandler return type to include Partial<SingleCompletionHandler>, allowing API providers that implement the completePrompt method to properly expose it for prompt enhancement.
Suggestions for improvement:
-
Type safety: Consider using a more specific type union instead of
Partial<SingleCompletionHandler>to make it clearer which providers support prompt enhancement. -
Documentation: The
SingleCompletionHandlerinterface would benefit from JSDoc documentation to help developers understand its purpose and usage. -
Error messages: The error message could include the provider name for better debugging context.
-
Type guards: Consider using a type guard function for even better type safety when checking for the
completePromptmethod.
Overall, the implementation is clean and maintains backward compatibility while fixing the reported issue.
hannesrudolph
added
the
Issue/PR - Triage
hannesrudolph
added
PR - Needs Preliminary Review
and removed
Issue/PR - Triage
|
I don’t think this will resolve the issue. The issue itself lacks information |
github-project-automation
bot
moved this from PR [Needs Prelim Review]
to Done
in Roo Code Roadmap
Description
This PR fixes the "Failed to enhance prompt" error reported in #6529. The issue was that the
buildApiHandlerfunction was returning anApiHandlertype, but many API providers actually implement bothApiHandlerandSingleCompletionHandlerinterfaces. ThecompletePromptmethod needed for prompt enhancement is part of theSingleCompletionHandlerinterface.Changes
buildApiHandlerreturn type fromApiHandlertoApiHandler & Partial<SingleCompletionHandler>singleCompletionHandlerto check for the existence ofcompletePromptmethod using optional chainingcompletePromptmethod to properly expose it for prompt enhancementTesting
npx vitest run src/utils/__tests__/enhance-prompt.spec.ts- all tests passnpx vitest run src/api/providers/__tests__/*.spec.ts- all provider tests passRelated Issue
Fixes #6529
Important
Update
buildApiHandlerreturn type and modifysingleCompletionHandlerto fix prompt enhancement error.buildApiHandlerreturn type toApiHandler & Partial<SingleCompletionHandler>inindex.tsto supportcompletePromptmethod.singleCompletionHandlerinsingle-completion-handler.tsto use optional chaining forcompletePromptmethod check.enhance-prompt.spec.tsand provider tests.This description was created by
for 5675471. You can customize this summary. It will automatically update as commits are pushed.